Getting started
===============


After installing ``pyNAVIS`` with

.. prompt:: bash $

   pip install pyNAVIS

You can start using it by creating a new Python file and importing the package:

.. prompt:: python \

   from pyNAVIS import *

With that, you will be able to use all the provided functionalities, which are specified in the :doc:`pyNAVIS package section <Installing>`.


Either if you installed the developer version of if you, as an user, want to get introduced with a set of code examples, 
you can find them in the ``/src/examples`` folder of the `Github repository <https://github.com/jpdominguez/pyNAVIS>`_ 
after downloading or cloning it. These examples will show you how to use most of ``pyNAVIS`` functionalities. 
In ``/src/`` you will find a ``main.py`` file that can be used to run those examples.

You can take a closer look at some of these main functionalities in the :doc:`Examples section <Examples/examples>`.


.. toctree::
   :maxdepth: 1
   :hidden:

   Examples/examples